home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / p_man / cat3 / Xm / XmClipboardLock.z / XmClipboardLock
Text File  |  1998-10-30  |  6KB  |  133 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddLLLLoooocccckkkk((((3333XXXX))))       UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV       XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddLLLLoooocccckkkk((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddLLLLoooocccckkkk - A clipboard function that locks the
  10.           clipboard
  11.  
  12.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  13.           #include <Xm/CutPaste.h>
  14.           int XmClipboardLock (_d_i_s_p_l_a_y, _w_i_n_d_o_w)
  15.                   Display * _d_i_s_p_l_a_y;
  16.                   Window  _w_i_n_d_o_w;
  17.           (vvvvooooiiiidddd)
  18.  
  19.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  20.           This page documents Motif 2.1.
  21.  
  22.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  23.           XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddLLLLoooocccckkkk locks the clipboard from access by another
  24.           application until XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddUUUUnnnnlllloooocccckkkk is called. All clipboard
  25.           functions lock and unlock the clipboard to prevent
  26.           simultaneous access. This function allows the application to
  27.           keep the clipboard data from changing between calls to
  28.           IIIInnnnqqqquuuuiiiirrrreeee and other clipboard functions. The application does
  29.           not need to lock the clipboard between calls to
  30.           XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddSSSSttttaaaarrrrttttCCCCooooppppyyyy and XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddEEEEnnnnddddCCCCooooppppyyyy or to
  31.           XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddSSSSttttaaaarrrrttttRRRReeeettttrrrriiiieeeevvvveeee and XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddEEEEnnnnddddRRRReeeettttrrrriiiieeeevvvveeee.
  32.  
  33.           If the clipboard is already locked by another application,
  34.           XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddLLLLoooocccckkkk returns an error status. Multiple calls to
  35.           this function by the same application increase the lock
  36.           level.
  37.  
  38.           _d_i_s_p_l_a_y   Specifies a pointer to the DDDDiiiissssppppllllaaaayyyy structure that
  39.                     was returned in a previous call to XXXXOOOOppppeeeennnnDDDDiiiissssppppllllaaaayyyy or
  40.                     XXXXttttDDDDiiiissssppppllllaaaayyyy.
  41.  
  42.           _w_i_n_d_o_w    Specifies the window ID of a widget that relates
  43.                     the application window to the clipboard. The
  44.                     widget's window ID can be obtained through
  45.                     XXXXttttWWWWiiiinnnnddddoooowwww.  The same application instance should
  46.                     pass the same window ID to each of the clipboard
  47.                     functions that it calls.
  48.  
  49.      RRRREEEETTTTUUUURRRRNNNN
  50.           _X_m_C_l_i_p_b_o_a_r_d_S_u_c_c_e_s_s
  51.                     The function was successful.
  52.  
  53.           _X_m_C_l_i_p_b_o_a_r_d_L_o_c_k_e_d
  54.                     The function failed because the clipboard was
  55.                     locked by another application. The application can
  56.                     continue to call the function again with the same
  57.                     parameters until the lock goes away. This gives
  58.                     the application the opportunity to ask if the user
  59.                     wants to keep trying or to give up on the
  60.  
  61.  
  62.  
  63.      Page 1                                         (printed 10/24/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddLLLLoooocccckkkk((((3333XXXX))))       UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV       XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddLLLLoooocccckkkk((((3333XXXX))))
  71.  
  72.  
  73.  
  74.                     operation.
  75.  
  76.      RRRREEEELLLLAAAATTTTEEEEDDDD
  77.           XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddEEEEnnnnddddCCCCooooppppyyyy(3), XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddEEEEnnnnddddRRRReeeettttrrrriiiieeeevvvveeee(3),
  78.           XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddSSSSttttaaaarrrrttttCCCCooooppppyyyy(3), XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddSSSSttttaaaarrrrttttRRRReeeettttrrrriiiieeeevvvveeee(3), and
  79.           XXXXmmmmCCCClllliiiippppbbbbooooaaaarrrrddddUUUUnnnnlllloooocccckkkk(3).
  80.  
  81.  
  82.  
  83.  
  84.  
  85.  
  86.  
  87.  
  88.  
  89.  
  90.  
  91.  
  92.  
  93.  
  94.  
  95.  
  96.  
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                         (printed 10/24/98)
  130.  
  131.  
  132.  
  133.